Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improving the RETURN and its docs on the apt_repository module #79658

Merged
merged 9 commits into from Feb 6, 2023
Merged

Improving the RETURN and its docs on the apt_repository module #79658

merged 9 commits into from Feb 6, 2023

Conversation

mateusrangel
Copy link
Contributor

SUMMARY

Improving docs on how we generate the default value of the filename parameter of the apt_repository module

Fixes #79306

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

lib/ansible/modules/apt_repository.py

@ansibot
Copy link
Contributor

ansibot commented Jan 4, 2023

Thanks for your Ansible docs contribution! We talk about Ansible documentation on matrix at #docs:ansible.im and on libera IRC at #ansible-docs if you ever want to join us and chat about the docs! We meet there on Tuesdays (see the Ansible calendar) and welcome additions to our weekly agenda items - scroll down to find the upcoming agenda and add a comment to put something new on that agenda.

click here for bot help

@ansibot ansibot added affects_2.15 docs This issue/PR relates to or includes documentation. docs_only All changes are to files within the docs/docsite/ directory module This issue/PR relates to a module. needs_triage Needs a first human triage before being processed. new_contributor This PR is the first contribution by a new community member. labels Jan 4, 2023
@ansibot
Copy link
Contributor

ansibot commented Jan 4, 2023

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

lib/ansible/modules/apt_repository.py:75:161: E501: line too long (161 > 160 characters)

click here for bot help

@ansibot ansibot added ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Jan 4, 2023
@ansibot ansibot removed ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Jan 4, 2023
@mateusrangel mateusrangel mentioned this pull request Jan 4, 2023
Closed
1 task
@ansibot ansibot removed the docs_only All changes are to files within the docs/docsite/ directory label Jan 5, 2023
@ansibot
Copy link
Contributor

ansibot commented Jan 5, 2023

The test ansible-test sanity --test pep8 [explain] failed with 2 errors:

lib/ansible/modules/apt_repository.py:155:1: W293: blank line contains whitespace
lib/ansible/modules/apt_repository.py:161:1: W293: blank line contains whitespace

click here for bot help

@ansibot ansibot added ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Jan 5, 2023
@ansibot ansibot removed ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Jan 5, 2023
@mateusrangel mateusrangel changed the title Improving docs on how we generate the default value of the filename parameter of the apt_repository module Improving the RETURN and its docs on the apt_repository module Jan 5, 2023
@mateusrangel
Copy link
Contributor Author

here it goes @bcoca

@nitzmahone nitzmahone removed the needs_triage Needs a first human triage before being processed. label Jan 5, 2023
@mateusrangel mateusrangel requested review from bcoca and removed request for nitzmahone January 5, 2023 21:29
@ansibot ansibot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Jan 5, 2023
bcoca
bcoca requested changes Jan 5, 2023
View reviewed changes
Copy link
Member

@bcoca bcoca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just create a new if on top of the for loop

lib/ansible/modules/apt_repository.py Show resolved Hide resolved
@ansibot ansibot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Jan 5, 2023
@mateusrangel mateusrangel requested review from bcoca and nitzmahone and removed request for bcoca and nitzmahone January 5, 2023 22:02
@mateusrangel
Copy link
Contributor Author

Any news? @nitzmahone

@ansibot ansibot added stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. stale_review Updates were made after the last review and the last review is more than 7 days old. labels Jan 16, 2023
samccann
samccann approved these changes Jan 30, 2023
View reviewed changes
Copy link
Contributor

@samccann samccann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docs portion LGTM

@samccann
Copy link
Contributor

@bcoca can this be merged now?

@ansibot ansibot removed needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. stale_review Updates were made after the last review and the last review is more than 7 days old. labels Feb 6, 2023
@nitzmahone
Copy link
Member

The existing tests for this module are ... less than fantastic (for a number of reasons), but I added a few just to at least validate the shape of the result for non-check-mode. So long as they pass CI, I'll hit merge. Thanks!

@ansibot ansibot removed the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Feb 6, 2023
@nitzmahone nitzmahone merged commit 32672c6 into ansible:devel Feb 6, 2023
@ansible ansible locked and limited conversation to collaborators Feb 13, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@l0b0 l0b0 l0b0 left review comments

@bcoca bcoca bcoca approved these changes

@nitzmahone nitzmahone nitzmahone approved these changes

@samccann samccann samccann approved these changes

Assignees
No one assigned
Labels
affects_2.15 docs This issue/PR relates to or includes documentation. has_issue module This issue/PR relates to a module. new_contributor This PR is the first contribution by a new community member.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Clarify apt_repository filename default
6 participants
@mateusrangel @ansibot @samccann @nitzmahone @l0b0 @bcoca